<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow: cfg/cfg_fwd.hpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_cfb2ffb2869bbb27b7281952022eb856.html">cfg</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">cfg_fwd.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="util__fwd_8hpp_source.html">flow/util/util_fwd.hpp</a>&quot;</code><br />
<code>#include &lt;boost/program_options.hpp&gt;</code><br />
<code>#include &lt;boost/filesystem.hpp&gt;</code><br />
<code>#include &lt;boost/any.hpp&gt;</code><br />
<code>#include &lt;vector&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
<code>#include &lt;ostream&gt;</code><br />
</div>
<p><a href="cfg__fwd_8hpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceflow"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceflow.html">flow</a></td></tr>
<tr class="memdesc:namespaceflow"><td class="mdescLeft">&#160;</td><td class="mdescRight">Catch-all namespace for the Flow project: A collection of various production-quality modules written in modern C++17, originally by ygoldfel. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceflow_1_1cfg"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceflow_1_1cfg.html">flow::cfg</a></td></tr>
<tr class="memdesc:namespaceflow_1_1cfg"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flow module that facilitates configuring modules, such as applications and APIs, via statically and/or dynamically parsed sets of name/value pairs from config sources like files and command lines. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceflow_1_1cfg_1_1fs"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceflow_1_1cfg_1_1fs.html">flow::cfg::fs</a></td></tr>
<tr class="memdesc:namespaceflow_1_1cfg_1_1fs"><td class="mdescLeft">&#160;</td><td class="mdescRight">Short-hand for <code>namespace <a class="el" href="namespaceboost_1_1filesystem.html" title="We may add some ADL-based overloads into this namespace outside flow.">boost::filesystem</a></code>. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceflow_1_1cfg_1_1opts"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceflow_1_1cfg_1_1opts.html">flow::cfg::opts</a></td></tr>
<tr class="memdesc:namespaceflow_1_1cfg_1_1opts"><td class="mdescLeft">&#160;</td><td class="mdescRight">Short-hand for <code>namespace boost::program_options</code>. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceboost_1_1filesystem"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1filesystem.html">boost::filesystem</a></td></tr>
<tr class="memdesc:namespaceboost_1_1filesystem"><td class="mdescLeft">&#160;</td><td class="mdescRight">We may add some ADL-based overloads into this namespace outside <code>flow</code>. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:af310e567f2763a9736eda686030e6311"><td class="memTemplParams" colspan="2">template&lt;typename Value_set &gt; </td></tr>
<tr class="memitem:af310e567f2763a9736eda686030e6311"><td class="memTemplItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceflow_1_1cfg.html#af310e567f2763a9736eda686030e6311">flow::cfg::operator&lt;&lt;</a> (std::ostream &amp;os, const Option_set&lt; Value_set &gt; &amp;val)</td></tr>
<tr class="memdesc:af310e567f2763a9736eda686030e6311"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes (briefly) an <a class="el" href="classflow_1_1cfg_1_1Option__set.html" title="The core config-parsing facility, which builds parsing/comparison/output capabilities on top of a giv...">Option_set</a> to a standard output stream.  <a href="namespaceflow_1_1cfg.html#af310e567f2763a9736eda686030e6311">More...</a><br /></td></tr>
<tr class="separator:af310e567f2763a9736eda686030e6311"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a696eee859b6e3f0fc0b6473a1d2836b0"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceflow_1_1cfg.html#a696eee859b6e3f0fc0b6473a1d2836b0">flow::cfg::value_set_member_id_to_opt_name</a> (util::String_view member_id)</td></tr>
<tr class="memdesc:a696eee859b6e3f0fc0b6473a1d2836b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Utility, used by <a class="el" href="option__set_8hpp.html#ae6bc0bcf28a53682a4c9a5fbe3a3837f" title="Macro the user must use, as prescribed in the flow::cfg::Option_set constructor doc header discussing...">FLOW_CFG_OPTION_SET_DECLARE_OPTION()</a> internally but made available as a public API in case it is useful, that converts a string containing a conventionally formatted data member name into the corresponding auto-determined config option name.  <a href="namespaceflow_1_1cfg.html#a696eee859b6e3f0fc0b6473a1d2836b0">More...</a><br /></td></tr>
<tr class="separator:a696eee859b6e3f0fc0b6473a1d2836b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafaf432a612183beab72175831aaa960"><td class="memTemplParams" colspan="2">template&lt;typename Key &gt; </td></tr>
<tr class="memitem:aafaf432a612183beab72175831aaa960"><td class="memTemplItemLeft" align="right" valign="top">std::string&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceflow_1_1cfg.html#aafaf432a612183beab72175831aaa960">flow::cfg::value_set_member_id_to_opt_name_keyed</a> (util::String_view member_id, const Key &amp;key)</td></tr>
<tr class="memdesc:aafaf432a612183beab72175831aaa960"><td class="mdescLeft">&#160;</td><td class="mdescRight">Similar to <a class="el" href="namespaceflow_1_1cfg.html#a696eee859b6e3f0fc0b6473a1d2836b0" title="Utility, used by FLOW_CFG_OPTION_SET_DECLARE_OPTION() internally but made available as a public API i...">value_set_member_id_to_opt_name()</a> but used by <a class="el" href="option__set_8hpp.html#a4fef7c1a28ef3510f71fae708c647590" title="Identical to FLOW_CFG_OPTION_SET_DECLARE_OPTION(), but with support for setting a value at a containe...">FLOW_CFG_OPTION_SET_DECLARE_OPTION_KEYED()</a> internally (also made available as a public API in case it is useful), that does the job of <a class="el" href="namespaceflow_1_1cfg.html#a696eee859b6e3f0fc0b6473a1d2836b0" title="Utility, used by FLOW_CFG_OPTION_SET_DECLARE_OPTION() internally but made available as a public API i...">value_set_member_id_to_opt_name()</a> in addition to substituting the last <code>[...]</code> fragment with a dot separator, followed by the <code>ostream</code> encoding of <code>key</code>.  <a href="namespaceflow_1_1cfg.html#aafaf432a612183beab72175831aaa960">More...</a><br /></td></tr>
<tr class="separator:aafaf432a612183beab72175831aaa960"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f5ff766e52aae24e6d5c876b3b26e96"><td class="memTemplParams" colspan="2">template&lt;typename Value &gt; </td></tr>
<tr class="memitem:a1f5ff766e52aae24e6d5c876b3b26e96"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceflow_1_1cfg.html#a1f5ff766e52aae24e6d5c876b3b26e96">flow::cfg::value_to_ostream</a> (std::ostream &amp;os, const Value &amp;val)</td></tr>
<tr class="memdesc:a1f5ff766e52aae24e6d5c876b3b26e96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Serializes a value of type <code>Value</code> to the given <code>ostream</code> suitably for output in Option_set-related output to user such as in help messages.  <a href="namespaceflow_1_1cfg.html#a1f5ff766e52aae24e6d5c876b3b26e96">More...</a><br /></td></tr>
<tr class="separator:a1f5ff766e52aae24e6d5c876b3b26e96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3782f31b7c020d7b08e250e89198ad4"><td class="memTemplParams" colspan="2">template&lt;typename Rep , typename Period &gt; </td></tr>
<tr class="memitem:ac3782f31b7c020d7b08e250e89198ad4"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceflow_1_1cfg.html#ac3782f31b7c020d7b08e250e89198ad4">flow::cfg::value_to_ostream</a> (std::ostream &amp;os, const boost::chrono::duration&lt; Rep, Period &gt; &amp;val)</td></tr>
<tr class="memdesc:ac3782f31b7c020d7b08e250e89198ad4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload that serializes a value of <code>chrono</code>-based <code>duration</code> including <code>Fine_duration</code> &ndash; which is recommended to use for Option_set-configured time durations &ndash; to the given <code>ostream</code> suitably for output in Option_set-related output to user such as in help messages.  <a href="namespaceflow_1_1cfg.html#ac3782f31b7c020d7b08e250e89198ad4">More...</a><br /></td></tr>
<tr class="separator:ac3782f31b7c020d7b08e250e89198ad4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66d8d4f33601a06cb7bc109b22800387"><td class="memTemplParams" colspan="2">template&lt;typename Element &gt; </td></tr>
<tr class="memitem:a66d8d4f33601a06cb7bc109b22800387"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceflow_1_1cfg.html#a66d8d4f33601a06cb7bc109b22800387">flow::cfg::value_to_ostream</a> (std::ostream &amp;os, const std::vector&lt; Element &gt; &amp;val)</td></tr>
<tr class="memdesc:a66d8d4f33601a06cb7bc109b22800387"><td class="mdescLeft">&#160;</td><td class="mdescRight">Overload that serializes a list value (with <code>Element</code> type itself similarly serializable) to the given <code>ostream</code> suitably for output in Option_set-related output to user such as in help messages.  <a href="namespaceflow_1_1cfg.html#a66d8d4f33601a06cb7bc109b22800387">More...</a><br /></td></tr>
<tr class="separator:a66d8d4f33601a06cb7bc109b22800387"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5fa05fd030711d6d8c76139467b13256"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceboost_1_1filesystem.html#a5fa05fd030711d6d8c76139467b13256">boost::filesystem::validate</a> (boost::any &amp;target, const std::vector&lt; std::string &gt; &amp;user_values, path *, int)</td></tr>
<tr class="memdesc:a5fa05fd030711d6d8c76139467b13256"><td class="mdescLeft">&#160;</td><td class="mdescRight">ADL-based overload of boost.program_options <code><a class="el" href="namespaceboost_1_1filesystem.html#a5fa05fd030711d6d8c76139467b13256" title="ADL-based overload of boost.program_options validate() to allow for empty boost::filesystem::path val...">validate()</a></code> to allow for empty <code>boost::filesystem::path</code> values in <a class="el" href="namespaceflow_1_1cfg.html" title="Flow module that facilitates configuring modules, such as applications and APIs, via statically and/o...">flow::cfg</a> config parsing as well as any other boost.program_options parsing in the application.  <a href="namespaceboost_1_1filesystem.html#a5fa05fd030711d6d8c76139467b13256">More...</a><br /></td></tr>
<tr class="separator:a5fa05fd030711d6d8c76139467b13256"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 28 2025 22:55:35 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
